Skip to main content
PUT
/
v2
/
templates
/
{templateId}
Update Pass Template Information
curl --request PUT \
  --url https://api.loyalty.dog/v2/templates/{templateId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "passType": "<string>",
  "description": {
    "description": "",
    "suppressStripShine": true,
    "sharing": {
      "method": "PKPassSharingMethodDisabled",
      "url": "<string>",
      "text": "<string>"
    },
    "appLaunchURL": "<string>",
    "associatedApps": [
      {}
    ],
    "associatedStoreIdentifiers": [
      123
    ],
    "associatedPlayIdentifiers": [
      "<string>"
    ],
    "beacons": [
      {
        "proximityUUID": "<string>",
        "major": 123,
        "minor": 123,
        "relevantText": "<string>"
      }
    ],
    "locations": [
      {
        "latitude": 0,
        "longitude": 0,
        "altitude": 0,
        "distance": 123,
        "relevantText": "<string>"
      }
    ],
    "barcodes": [
      {
        "message": "<string>",
        "messageEncoding": "iso-8859-1",
        "altText": "<string>",
        "verifier": true,
        "disabled": true
      }
    ],
    "barcode": {
      "message": "<string>",
      "messageEncoding": "iso-8859-1",
      "altText": "<string>",
      "verifier": true,
      "disabled": true
    },
    "labelColor": "<string>",
    "backgroundColor": "<string>",
    "foregroundColor": "<string>",
    "logoText": "<string>",
    "relevantDate": "2023-11-07T05:31:56Z",
    "expirationDate": "2023-11-07T05:31:56Z",
    "voided": true,
    "userInfo": {},
    "generic": {
      "headerFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ],
      "primaryFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ],
      "secondaryFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ],
      "backFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ],
      "auxiliaryFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ]
    },
    "coupon": {
      "headerFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ],
      "primaryFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ],
      "secondaryFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ],
      "backFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ],
      "auxiliaryFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ]
    },
    "storeCard": {
      "headerFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ],
      "primaryFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ],
      "secondaryFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ],
      "backFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ],
      "auxiliaryFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ]
    },
    "eventTicket": {
      "headerFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ],
      "primaryFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ],
      "secondaryFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ],
      "backFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ],
      "auxiliaryFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ]
    },
    "boardingPass": {
      "headerFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ],
      "primaryFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ],
      "secondaryFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ],
      "backFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ],
      "auxiliaryFields": [
        {
          "key": "<string>",
          "value": "<string>",
          "label": "<string>",
          "attributedValue": "<string>",
          "changeMessage": "<string>",
          "dataDetectorTypes": [],
          "isRelative": true,
          "ignoresTimeZone": true,
          "currencyCode": "<string>",
          "googleHideOnCard": true,
          "googleHideOnBack": true,
          "googleFieldType": "<string>",
          "googleUri": "<string>",
          "googleLabel": "<string>",
          "googleValue": "<string>"
        }
      ]
    }
  },
  "disablePush": true,
  "placeholders": [
    {
      "name": "<string>",
      "type": "text",
      "displayName": "<string>",
      "defaultValue": "<string>",
      "points": 123,
      "options": "<string>",
      "required": true
    }
  ],
  "branding": {
    "titleText": "<string>",
    "headerText": "<string>",
    "bodyTextColor": "<string>",
    "footerTextColor": "<string>",
    "footerBackgroundColor": "<string>",
    "footerImage": {
      "key": "<string>",
      "url": "<string>"
    }
  },
  "payment": {
    "enabled": true,
    "price": 123,
    "currency": "<string>",
    "providerSettings": {
      "username": "<string>",
      "password": "<string>",
      "signature": "<string>",
      "sandbox": true,
      "itemName": "<string>",
      "publishableKey": "<string>",
      "secretKey": "<string>",
      "publicKey": "<string>",
      "privateKey": "<string>"
    }
  },
  "restrictions": {
    "quantityRestriction": 123,
    "redemptionRestriction": 123,
    "passwordProtection": "<string>",
    "sharingRestriction": true,
    "dateRestriction": "2023-11-07T05:31:56Z"
  },
  "actions": {
    "redeem": true,
    "reactivate": true,
    "updateFields": [
      "<string>"
    ]
  },
  "translations": {
    "baseLanguage": "en",
    "strings": {}
  },
  "allowPassImages": [],
  "stripImage": {
    "generator": "stamp",
    "placeholder": "<string>",
    "stamps": 123,
    "backgroundColor": "<string>",
    "backgroundImage": {
      "key": "<string>",
      "url": "<string>"
    },
    "stampedColor": "<string>",
    "stampedImage": {
      "key": "<string>",
      "url": "<string>"
    },
    "unstampedColor": "<string>",
    "unstampedImage": {
      "key": "<string>",
      "url": "<string>"
    }
  }
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

JWT access token obtained from POST /v2/token.

Headers

​
authorization
string | null

Path Parameters

​
templateId
required
Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

Body

application/json
​
name
string
required
​
passType
string | null
​
description
TemplatePass · object
​
disablePush
boolean | null
​
placeholders
TemplatePlaceholder · object[] | null
​
branding
TemplateBranding · object
​
payment
TemplatePayment · object
​
restrictions
TemplateRestrictions · object
​
actions
TemplateAction · object
​
translations
TemplateTranslation · object
​
allowPassImages
enum<string>[] | null

Supported images Boarding pass: logo, icon, footer Coupon: logo, icon, strip Event ticket: logo, icon, strip, background, thumbnail If you specify a strip image, do not specify a background image or a thumbnail. Generic: logo, icon, thumbnail Store card: logo, icon, strip

Args: StrEnum (type): description

Available options:
logo,
icon,
strip,
footer,
background,
thumbnail
​
stripImage
TemplateStripImage · object

Response

Successful Response